/*
 * Copyright (c) 2003-2005
 * XDoclet Team
 * All rights reserved.
 */
package org.xdoclet.plugin.hibernate.qtags;

/**
 * Declare a named query for class. Queries are taken from defining class only.
 * no inheritance here due to uniqueness of names
 *
 * @qtags.location class
 */
public interface HibernateQueryTag extends com.thoughtworks.qdox.model.DocletTag {
    /**
     * Query Attribute
     *
     */
    String getCacheRegion();

    /**
     * Query Attribute
     *
     * @qtags.allowed-value true
     * @qtags.allowed-value false
     */
    String getCacheable();

    /**
     * Name of this query
     *
     * @qtags.required
     */
    String getName_();

    /**
     * Query contents
     *
     */
    String getQuery();

    /**
     * Query Parameter Representation.
     *
     * @qtags.allowed-value dom4j
     * @qtags.allowed-value dynamic-map
     * @qtags.allowed-value pojo
     */
    String getRepresentation();
}